ci: update issue and PR templates with SDK-specific fields - #554
Merged
Conversation
Bug report template now asks for a minimal TypeScript reproduction and the error message/stack trace, not just free-text steps. Feature request template now asks for a proposed method signature and example call instead of generic problem/solution prose. PR template checklist adds CHANGELOG.md and "API surface intentional" as explicit items, matching what CONTRIBUTING.md already requires but the old template didn't surface. Closes Lead-Studios#548
|
@jeorgei Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the existing issue and PR templates with the fields #548 asks for. The repo
already had
.github/ISSUE_TEMPLATE/*.mdandPULL_REQUEST_TEMPLATE.md— this is acontent update to those three files, not new files (the issue's "the repo has no
templates" framing was slightly off; they existed but were missing the SDK-specific
fields).
What Changed
bug_report.md— adds a fenced TypeScript code block for a minimal reproduction and adedicated error-message/stack-trace field
feature_request.md— adds "use case," "proposed method signature" (as a TS snippet),and "example call," alongside the existing "alternatives considered"
PULL_REQUEST_TEMPLATE.md— checklist now explicitly includesCHANGELOG.md updatedand
API surface change is intentional, matching whatCONTRIBUTING.mdalreadyrequires (CI fails on
src/changes without a CHANGELOG entry) but the template neversurfaced as a checkbox. Kept the existing tests/docs/build/lint checks rather than
removing them.
Checklist
CHANGELOG.md— not updated; nothing undersrc/changed, so CI's changelog checkdoesn't apply here
npm run build/npm test/npm run lintchanges to verify beyondconfirming the templates render correctly on a draft PR
closes #548
closes #545
closes #547
closes #539